package com.airbat.prize.modules.system.service.area;

import com.airbat.prize.common.pojo.PageResult;
import com.airbat.prize.modules.system.controller.area.vo.SysAreaCreateReqVO;
import com.airbat.prize.modules.system.controller.area.vo.SysAreaExportReqVO;
import com.airbat.prize.modules.system.controller.area.vo.SysAreaPageReqVO;
import com.airbat.prize.modules.system.controller.area.vo.SysAreaUpdateReqVO;
import com.airbat.prize.modules.system.dal.dataobject.area.SysAreaDO;

import javax.validation.Valid;
import java.util.Collection;
import java.util.List;

/**
 * 全国地区 Service 接口
 *
 * @author 郑剑
 */
public interface SysAreaService {

    /**
     * 初始化部门的本地缓存
     */
    void initLocalCache();

    /**
     * 创建全国地区
     *
     * @param createReqVO 创建信息
     * @return 编号
     */
    String createArea(@Valid SysAreaCreateReqVO createReqVO);

    /**
     * 更新全国地区
     *
     * @param updateReqVO 更新信息
     */
    void updateArea(@Valid SysAreaUpdateReqVO updateReqVO);

    /**
     * 删除全国地区
     *
     * @param id 编号
     */
    void deleteArea(String id);

    /**
     * 获得全国地区
     *
     * @param code 编号
     * @return 全国地区
     */
    SysAreaDO getArea(String code);

    /**
     * 缓存中获得全国地区
     *
     * @param code 编号
     * @return 全国地区
     */
    SysAreaDO getAreaFromCache(String code);

    /**
     * 获得全国地区列表
     *
     * @param ids 编号
     * @return 全国地区列表
     */
    List<SysAreaDO> getAreaList(Collection<String> ids);

    /**
     * 获得含有经纬度范围的地区列表
     *
     * @return 全国地区列表
     */
    List<SysAreaDO> getAreaListForRange();

    /**
     * 获得全国地区分页
     *
     * @param pageReqVO 分页查询
     * @return 全国地区分页
     */
    PageResult<SysAreaDO> getAreaPage(SysAreaPageReqVO pageReqVO);

    /**
     * 获得全国地区列表, 用于 Excel 导出
     *
     * @param exportReqVO 查询条件
     * @return 全国地区列表
     */
    List<SysAreaDO> getAreaList(SysAreaExportReqVO exportReqVO);

}
